Record Audio Params JSON Reference
| Declared in | Voiceflow.schema.json |
Overview
Specifies the parameters for recording audio. "recordAudioParams" configuration is used in Voiceflow Modules of types "recordAudio", "audioDialog" and "audioListener".
Note: Unless stated otherwise, value of properties that are of type "string" can be updated at runtime by an application if their value is entered as a field name wrapped by "$[" and "]". If a property is of a type other than "string", then an additional property of type "string" with the same property name appended with the string "Runtime" is added to have its value entered as a field name wrapped by "$[" and "]". This allows the application to set the value of the field name at runtime to be the value of the original non-runtime property. Valid values of runtime fields override the values of non-runtime properties.
Tasks
-
idpropertySpecifies an ID form the audio recording task. User Defined. The value can be set at runtime using
"$[<FieldName>]"entry convention.Parameter is optional.
-
promptIDpropertyThe ID of an Audio Prompt Module to process for audio playback either after or during audio recording, or to process as the source of the audio data to be recorded. This property is used only in a
"recordAudio"type Voiceflow Module. The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
recordFromPromptpropertySpecifies if audio data source for the audio recording is the audio content of an Audio Prompt Module if
"promptID"is defined and configured. Default:"false"which means that Audio Prompt Module will be processed for audio playback. This property is used only in a"recordAudio"type Voiceflow Module. The value can be set at runtime using the"recordFromPromptRuntime"property.Parameter is optional.
-
recordFromPromptRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"recordFromPrompt"property. Example:"$[RecordFromPrompt]".Parameter is optional.
-
recordWhilePlaypropertySpecifies if audio recording will occur at the same time as audio playback if
"promptID"is configured and"recordFromPrompt"is"false". Default:"false"which means that audio recording will start after audio playback ends. This property is used only in a"recordAudio"type Voiceflow Module. The value can be set at runtime using the"recordWhilePlayRuntime"property.Parameter is optional.
-
recordWhilePlayRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"recordWhilePlay"property. Example:"$[RecordWhilePlay]".Parameter is optional.
-
stopPlayAudioWhenSpeechDetectedpropertySpecifies if audio playback should automatically stop if speech is detected during audio recording. Default:
"false". if"true"then this requires"vadParams"to be also configured. The value can be set at runtime using the"stopPlayAudioWhenSpeechDetectedRuntime"property.Parameter is optional.
-
stopPlayAudioWhenSpeechDetectedRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"stopPlayAudioWhenSpeechDetectedRuntime"property. Example:"$[StopPlayAudioWhenSpeechDetectedRuntime]".Parameter is optional.
-
stopPlayAudioWhenValidSRHypothesispropertySpecifies if audio playback should automatically stop if a valid Speech Recognition hypothesis is recognized during audio recording. Default:
"false". Requires"stopPlaySRHypothesisList"to be configured. This property is used only in"audioDialog"and"audioListener"Voiceflow Module types. The value can be set at runtime using the"stopPlayAudioWhenValidSRHypothesisRuntime"property.Parameter is optional.
-
stopPlayAudioWhenValidSRHypothesisRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"stopPlayAudioWhenValidSRHypothesis"property. Example:"$[StopPlayAudioWhenValidSRHypothesis]".Parameter is optional.
-
enableStopPlaySRHypothesisPartialpropertySpecifies if audio playback should automatically stop if a partial Speech Recognition hypothesis is recognized during audio recording. Default:
"false". This property is used only in"audioDialog"and"audioListener"Voiceflow Module types. The value can be set at runtime using the"enableStopPlaySRHypothesisPartialRuntime"property.Parameter is optional.
-
enableStopPlaySRHypothesisPartialRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"enableStopPlaySRHypothesisPartial"property. Example:"$[EnableStopPlaySRHypothesisPartial]".Parameter is optional.
-
stopPlaySRHypothesisListpropertyString containing multiple SR Hypotheses separated by
"|"delimiter. Audio recording will automatically stop if SR hypothesis matches any hypothesis in the list. This property is used only in"audioDialog"and"audioListener"Voiceflow Module types. Example:"stopPlaySRHypothesisList":"hey veronica | Go to sleep | wake up". The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
fileNamepropertyFile name that will contain the recorded audio. The value can be set at runtime using
"$[<FieldName>]"entry convention.Parameter is optional.
-
fileLocationpropertyURL or location of folder where
"fileName"containing the recorded audio will be located.The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
languageCodepropertySpecifies the name of the folder specific to language locale. This folder name is used as part of
"fileLocation"for the final location to save"fileName"at. Default:"en-US". The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
notifyPosMspropertyTime duration in milliseconds for, when audio recording is reached, a notification is sent to Client. Default: 0. The value can be set at runtime using the
"notifyPosMsRuntime"property.Parameter is optional.
-
notifyPosMsRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"notifyPosMs"property. Example:"$[NotifyPosMs]".Parameter is optional.
-
audioFormatpropertyAudio format of raw audio. Use if audio format from source is not available or cannot be automatically detected. Values:
"pcm_8khz","pcm_16khz","pcm_32khz","pcm_48khz","wav","compressed"(experimental),"preencoded"(experimental),"media", or"raw". Default:"pcm_16khz". The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
audioCodecproperty(Experimental) The audio codec parameters to use for audio playback and audio recording if one is not specified or supported in
"audioFormat"property. Example:"payloadType": 93,"payloadName":"L16","payloadFrequency": 16000,"audioPacketSizeBytes": 160,"numberChannelsPerAudioSample": 1,"sampleRateBitsPerSecond": 256000.Parameter is optional.
-
vadParamspropertySpecifies the Voice Activity Detection (VAD) parameters used for processing recorded audio.
Parameter is optional.
-
aecParamspropertySpecifies the Acoustic Echo Cancelation (AEC) parameters used for processing recorded audio.
Parameter is optional.
-
stopRecordParamspropertySpecifies the recording audio thresholds, which when reached, result in record audio to stop automatically.
Parameter is optional.
Properties
aecParams
"aecParams": object - AECParams
Discussion
Specifies the Acoustic Echo Cancelation (AEC) parameters used for processing recorded audio.
Parameter is optional.
Declared In
Voiceflow.schema.json
audioCodec
"audioCodec": object - AudioCodec
Discussion
(Experimental) The audio codec parameters to use for audio playback and audio recording if one is not specified or supported in "audioFormat" property. Example: "payloadType": 93, "payloadName": "L16", "payloadFrequency": 16000, "audioPacketSizeBytes": 160, "numberChannelsPerAudioSample": 1, "sampleRateBitsPerSecond": 256000.
Parameter is optional.
Declared In
Voiceflow.schema.json
audioFormat
"audioFormat": string
Discussion
Audio format of raw audio. Use if audio format from source is not available or cannot be automatically detected. Values: "pcm_8khz", "pcm_16khz", "pcm_32khz", "pcm_48khz", "wav", "compressed" (experimental), "preencoded" (experimental), "media", or "raw". Default: "pcm_16khz". The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
enableStopPlaySRHypothesisPartial
"enableStopPlaySRHypothesisPartial": boolean
Discussion
Specifies if audio playback should automatically stop if a partial Speech Recognition hypothesis is recognized during audio recording. Default: "false". This property is used only in "audioDialog" and "audioListener" Voiceflow Module types. The value can be set at runtime using the "enableStopPlaySRHypothesisPartialRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
enableStopPlaySRHypothesisPartialRuntime
"enableStopPlaySRHypothesisPartialRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "enableStopPlaySRHypothesisPartial" property. Example: "$[EnableStopPlaySRHypothesisPartial]".
Parameter is optional.
Declared In
Voiceflow.schema.json
fileLocation
"fileLocation": string
Discussion
URL or location of folder where "fileName" containing the recorded audio will be located.The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
fileName
"fileName": string
Discussion
File name that will contain the recorded audio. The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
id
"id": string
Discussion
Specifies an ID form the audio recording task. User Defined. The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
languageCode
"languageCode": string
Discussion
Specifies the name of the folder specific to language locale. This folder name is used as part of "fileLocation" for the final location to save "fileName" at. Default: "en-US". The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
notifyPosMs
"notifyPosMs": integer
Discussion
Time duration in milliseconds for, when audio recording is reached, a notification is sent to Client. Default: 0. The value can be set at runtime using the "notifyPosMsRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
notifyPosMsRuntime
"notifyPosMsRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "notifyPosMs" property. Example: "$[NotifyPosMs]".
Parameter is optional.
Declared In
Voiceflow.schema.json
promptID
"promptID": string
Discussion
The ID of an Audio Prompt Module to process for audio playback either after or during audio recording, or to process as the source of the audio data to be recorded. This property is used only in a "recordAudio" type Voiceflow Module. The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
recordFromPrompt
"recordFromPrompt": boolean
Discussion
Specifies if audio data source for the audio recording is the audio content of an Audio Prompt Module if "promptID" is defined and configured. Default: "false" which means that Audio Prompt Module will be processed for audio playback. This property is used only in a "recordAudio" type Voiceflow Module. The value can be set at runtime using the "recordFromPromptRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
recordFromPromptRuntime
"recordFromPromptRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "recordFromPrompt" property. Example: "$[RecordFromPrompt]".
Parameter is optional.
Declared In
Voiceflow.schema.json
recordWhilePlay
"recordWhilePlay": boolean
Discussion
Specifies if audio recording will occur at the same time as audio playback if "promptID" is configured and "recordFromPrompt" is "false". Default: "false" which means that audio recording will start after audio playback ends. This property is used only in a "recordAudio" type Voiceflow Module. The value can be set at runtime using the "recordWhilePlayRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
recordWhilePlayRuntime
"recordWhilePlayRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "recordWhilePlay" property. Example: "$[RecordWhilePlay]".
Parameter is optional.
Declared In
Voiceflow.schema.json
stopPlayAudioWhenSpeechDetected
"stopPlayAudioWhenSpeechDetected": boolean
Discussion
Specifies if audio playback should automatically stop if speech is detected during audio recording. Default: "false". if "true" then this requires "vadParams" to be also configured. The value can be set at runtime using the "stopPlayAudioWhenSpeechDetectedRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
stopPlayAudioWhenSpeechDetectedRuntime
"stopPlayAudioWhenSpeechDetectedRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "stopPlayAudioWhenSpeechDetectedRuntime" property. Example: "$[StopPlayAudioWhenSpeechDetectedRuntime]".
Parameter is optional.
Declared In
Voiceflow.schema.json
stopPlayAudioWhenValidSRHypothesis
"stopPlayAudioWhenValidSRHypothesis": boolean
Discussion
Specifies if audio playback should automatically stop if a valid Speech Recognition hypothesis is recognized during audio recording. Default: "false". Requires "stopPlaySRHypothesisList" to be configured. This property is used only in "audioDialog" and "audioListener" Voiceflow Module types. The value can be set at runtime using the "stopPlayAudioWhenValidSRHypothesisRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
stopPlayAudioWhenValidSRHypothesisRuntime
"stopPlayAudioWhenValidSRHypothesisRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "stopPlayAudioWhenValidSRHypothesis" property. Example: "$[StopPlayAudioWhenValidSRHypothesis]".
Parameter is optional.
Declared In
Voiceflow.schema.json
stopPlaySRHypothesisList
"stopPlaySRHypothesisList": string
Discussion
String containing multiple SR Hypotheses separated by "|" delimiter. Audio recording will automatically stop if SR hypothesis matches any hypothesis in the list. This property is used only in "audioDialog" and "audioListener" Voiceflow Module types. Example: "stopPlaySRHypothesisList": "hey veronica | Go to sleep | wake up". The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
stopRecordParams
"stopRecordParams": object - StopRecordParams
Discussion
Specifies the recording audio thresholds, which when reached, result in record audio to stop automatically.
Parameter is optional.
Declared In
Voiceflow.schema.json
vadParams
"vadParams": object - VADParams
Discussion
Specifies the Voice Activity Detection (VAD) parameters used for processing recorded audio.
Parameter is optional.
Declared In
Voiceflow.schema.json